/*
 * Copyright (c) 2009-2010, okazoh_tk. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  - Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *  - Neither the name of the copyright holder nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ALKES_IMAGE_DECODER_H_INCLUDED_
#define ALKES_IMAGE_DECODER_H_INCLUDED_

#include "alkes/internal.h"
#include "alkes/media/ImageBuffer.h"
#include "alkes/media/ImageBufferFactory.h"

namespace alkes {

class ImageProvider;

/// \addtogroup media
//@{

/** Interface to decode image from file and in memory.
 */
class AL_EXPORT ImageDecoder
{
    AL_DECLARE_ROOT_CLASS(ImageDecoder);

public:

    /** Default constructor.
     */
    ImageDecoder(ImageBufferFactory* factory);

    /** Destructor.
     */
    virtual ~ImageDecoder() = 0;

    /** Get result image.
     */
    ImageBuffer* getResult();

    /** Decode image from file.
     */
    bool decode(const char* imagefile);

    /** Decode image from address.
     */
    bool decode(const void* address, uint32_t size);

protected:

    class DecodeHelper;

    /** Implement to decode.
     */
    virtual bool onDecode(const char* imagefile);

    /** Implement to decode.
     */
    virtual bool onDecode(const void* address, uint32_t size);

    /** Utility for decoder.
    */
    ImageBuffer* createImageBuffer(uint16_t width, uint16_t height, PixelFormat format);

    /** Register image buffer to image container.
    */
    bool registerImageBuffer(ImageBuffer* buffer);

    /** Get factory interface.
    */
    ImageBufferFactory* getImageBufferFactory();

private:
    friend class ImageProvider;

    ImageDecoder(const ImageDecoder&);
    void operator=(const ImageDecoder&);

private:
    ImageBuffer* result_;
    ImageBufferFactory* factory_;
};

//@}

}

#endif
